Instalação do Sphinx¶

Para realizar a Instalação os seguintes comandos devem ser digitados no terminal.

pip install -U sphinx && pip install sphinx_rtd_theme && sphinx-quickstart docs

Depois de fazer a Instalação é necessário configurar alguns arquivos:

Adicionar no conf.py:

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
]

html_theme = 'sphinx_rtd_theme'

criar um arquivo chamado:

.nojekyll

criar um arquivo chamdo:

index.html

e inserir as sequintes linhas:

<html>
<head>
<meta http-equiv="refresh" content="0; url=html/index.html" />
</head>
<body></body>
</html>

Alterar o arquivo Make:

BUILDDIR = _build   para     BUILDDIR = .

Para atualizar o docs

cd docs
make html

gh-pages

criar gh-pages

.gitignore

docs/doctrees